package com.common.service;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;


/**
 * Generic Manager that talks to GenericDao to CRUD POJOs.
 * 
 * <p>
 * Extend this interface if you want typesafe (no casting necessary) managers for your domain objects.
 * 
 * @author <a href="mailto:nickevin@gmail.com">Kevin Nick</a>
 * @param <T>
 *            a type variable
 * @param <PK>
 *            the primary key for that type
 */

public interface GenericManager<T, PK extends Serializable> {

	/**
	 * Generic method used to get all objects of a particular type. This is the same as lookup up all rows in a table.
	 * 
	 * @return List of populated objects
	 */
	List<T> getAll() throws ServiceException;

	List<T> getAll(int start, int limit) throws ServiceException;

	/**
	 * Generic method to get an object based on class and identifier. An ObjectRetrievalFailureException Runtime Exception is thrown if nothing is found.
	 * 
	 * @param id
	 *            the identifier (primary key) of the object to get
	 * @return a populated object
	 * @see org.springframework.orm.ObjectRetrievalFailureException
	 */
	T get(PK id) throws ServiceException;

	/**
	 * Checks for existence of an object of type T using the id arg.
	 * 
	 * @param id
	 *            the identifier (primary key) of the object to get
	 * @return - true if it exists, false if it doesn't
	 */
	boolean exists(PK id) throws ServiceException;

	/**
	 * Generic method to save an object - handles both update and insert.
	 * 
	 * @param object
	 *            the object to save
	 * @return the updated object
	 */
	T save(T object) throws ServiceException;

	void saveAll(Collection<T> col) throws ServiceException;

	/**
	 * Generic method to delete an object based on class and id.
	 * 
	 * @param id
	 *            the identifier (primary key) of the object to remove
	 */
	void remove(PK id) throws ServiceException;

	void removeAll(Collection<T> col) throws ServiceException;
}
